home *** CD-ROM | disk | FTP | other *** search
/ Belgian Amiga Club - ADF Collection / BS1 part 23.zip / BS1 part 23 / Harddisk a la carte v1.6.3.adf / Docs / Carte.doc
Text File  |  1991-05-11  |  8KB  |  177 lines
  1.                 HARDDISK A LA CARTE V1.63 © 1991 Infocorner
  2.                 -------------------------------------------
  3.                             By The G - May 1991
  4.  
  5. 1. INTRODUCTION
  6. ---------------
  7.  
  8. 'Harddisk a la carte' (short: CARTE) is a DOS menu program which enables
  9. you to startup your desired programs without having to type all the necessary
  10. CLI commands every time. Although the name implies it's only useful for
  11. harddisk owners, it can just as well be used with any other type of drive.
  12.  
  13. 2. THE BASICS
  14. -------------
  15.  
  16. The easiest way to start CARTE is by simply typing 'run carte'.
  17. When started, CARTE will search for the file 'carte.config' in the 
  18. volume 'CARTE:'. Therefore, before you start CARTE, you have to assign 
  19. a directory to act as this volume with the ASSIGN command. 
  20. (e.g. assign CARTE: dh0:s). When you have started CARTE as described
  21. above, CARTE will open a screen and display an Item-Table, which can 
  22. contain up to 20 items.
  23.  
  24. An item can be selected be clicking the the left mouse button within
  25. the item select box, or be pressing the item key, that is the key 
  26. displayed on the left/right side of the item.
  27.  
  28. By clicking the right mouse button (menu button) over one of the
  29. items a requester will appear with which you can edit this menu item. 
  30. Every item is made out of two parts: 
  31.  
  32.  (1) TITLE:         This is the title as it will be shown in the menu.
  33.                     e.g. 'Deluxe Paint V3.21'
  34.                     The title can be about 30 characters long.
  35.  
  36.  (2) COMMAND LINE:  This is the sequence of cli commands you want to
  37.                     have executed in order to start up this program.
  38.                     The different commands are seperated by a semicolon (;)
  39.                     and can be any command/program available.
  40.                     e.g. assign fonts: dh0:fonts;cd DPAINT;DPaint
  41.  
  42. When you do not enter a command line, but you do enter a title, the 
  43. program displays the title in a different colour. This way you can create
  44. a sort of headline. 
  45.  
  46. After you've selected an item the menu screen closes and the commands from
  47. the command sequence will be executed. When all executed programs have
  48. stopped (or have been quit) the menu automatically reopens and you can
  49. select another item.
  50.  
  51. 3. MOUSE MENUS
  52. --------------
  53.  
  54. By holding down one of the mouse buttons outside the item select boxes
  55. a menu will appear. Items from this menu can be selected in a similar
  56. way as normal 'intuition' menus. Just hold down one of the menu buttons
  57. while positioning the pointer over the desired item. Releasing the button
  58. again will then select the item. When the button is released while the
  59. pointer is not over one of the items, none of the items will be selected
  60. and the (mouse button) menu will just disappear.
  61.  
  62. Here now follows a description of the items of the two menus:
  63.  
  64. Right Mouse Button Menu:
  65.  
  66.  (1) LOAD        - (re)Loads the previously saved menu item settings.
  67.                    (i.e. th carte.config file)
  68.  (2) SAVE        - Saves the current item settings. (carte.config)
  69.  (3) ICONIFY     - 'Iconifies' the program. That is, it closes the 
  70.                    menu screen and opens a small window on top of your CLI
  71.                    window (or workbench). You can now reactivate the menu
  72.                    by closing this window or by pressing the key 
  73.                    combination: CTRL - LEFT AMIGA - HELP
  74.  (4) AUTO RETURN - When selected (default) the menu will automatically
  75.                    reappear after all commands have been executed.
  76.                    When deselected, the menu iconifies before it
  77.                    starts execting the selected item commands.
  78.                    (see also ICONIFY)
  79.  (5) BE VERBOSE  - When selected the commands are printed while executed.
  80.  (6) KEYS        - When selected (default) the key interrupt will be
  81.                    active in iconified mode, enabling you to start the
  82.                    items through the key combination:
  83.                    CTRL-LEFT_AMIGA-<item key>
  84.  
  85.                    The last three options ('BE VERBOSE' and 'AUTO RETURN' 
  86.                    and 'KEYS') are 'toggle items' that is, they're either 
  87.                    selected or deselected. When selected they will be 
  88.                    displayed in another colour.
  89.  
  90.  (7) QUIT        - Quit the menu entirely.
  91.  
  92. For more information about ICONIFY (3) and KEYS (6) see section 4:
  93. CARTE AT ITS BEST
  94.  
  95. Left Mouse Button Menu:
  96.  
  97.  (1) COPY ITEM  - When you select this item you are expected to select
  98.                   two items. The values of the first item (title and 
  99.                   command sequence) will then be copied into the second item.
  100.  (2) SWAP ITEM  - Just like COPY ITEM you are expected to selected two
  101.                   items. Their values will then be swapped.
  102.  (3) UNDO       - Restores the values of the items which were affected
  103.                   by COPY ITEM or SWAP ITEM.
  104.  (4) HELP       - Gives on-line help about the keyboard shortcuts in
  105.                   iconified mode. (for more information see section 4: 
  106.                   CARTE AT ITS BEST)
  107.  (5) ABOUT      - Show the About window again.
  108.  
  109.  
  110. 4. CARTE AT ITS BEST
  111. --------------------
  112.  
  113. An alternative way to start CARTE is to supply it with the optional
  114. parameter SILENT : 'run carte silent'.
  115. CARTE will now start in 'iconified' mode, i.e. it opens a small window
  116. at the top of your screen. In this mode you can execute your desired item
  117. simply by holding down the CTRL and LEFT-AMIGA keys and pressing the
  118. appropriate item key e.g. CTRL-LEFT_AMIGA-'B'. (for this, the small CARTE 
  119. window doesn't have to be active!!). This way you can start the items 
  120. as fast as possible without having to open the entire menu every time. 
  121. You can reopen the menu by closing the small window or by pressing HELP 
  122. while holding down the CTRL and LEFT-AMIGA keys.
  123.  
  124. 5. COMMANDLINE OPTIONS
  125. ----------------------
  126.  
  127. To start CARTE: form the CLI:
  128.  
  129.    run carte [?|CLOSE] [SILENT] [TITLE <name>] [LACE] [NOABOUT]
  130.  
  131. CARTE can take either the single parameter '?' or 'CLOSE' or any
  132. of the other parameters in any sequence.
  133.  
  134. Description:
  135.  
  136.    ?       : 
  137.    CLOSE   : With this option you can close a pending CARTE task from
  138.              the commandline (or from within a shell script!)
  139.    SILENT  : When supplied, CARTE will start in iconified mode. For
  140.              more about this see section 4: CARTE AT ITS BEST
  141.    TITLE   : With this option you can supply a custom name (max. 24 chars)
  142.              for the icon window.
  143.    LACE    : Will start CARTE in interlace. (implemented for all those
  144.              'lucky bastards' out there with flicker fixers and multi sync
  145.              monitors!)
  146.    NOABOUT : CARTE will refrain from displaying the ABOUT window.
  147.  
  148. 6. WELL ..EH..THE WORKBENCH
  149. ---------------------------
  150.  
  151. CARTE does work with the WorkBench, but you have to take the following
  152. things into consideration:
  153.  
  154. - I've not supplied a .info file, so you have to make your own.
  155.   In this .info file you have to set the tool types to something like
  156.   WINDOW=CON:40/20/200/50/Le Garçon
  157. - You have to supply the full path with each program.
  158.   e.g. dh0:tools/local/user/lib/staff/demos/streetlife/partyanimation
  159. - don't use the 'cd' command, it is known to crash in the workbench!
  160.  
  161. 7. WHAT'S LEFT...BUGS?
  162. ----------------------
  163.  
  164. If you've spotted bugs or you have some interesting ideas/improvements
  165. you wish to have implemented you can contact me via:
  166.  
  167.                                 Infocorner
  168.                                P.O. BOX 223
  169.                             3800 AE Amersfoort
  170.                                   Holland
  171.  
  172. or
  173.  
  174.                                   E-Mail:
  175.                          gpverhag@praxis.cs.ruu.nl
  176.  
  177.